/* 
 * Gneat (http://gneat.org)
 *
 * (C) Copyright 2011 and beyond - Claudio Stella, all rights reserved.
 *
 * This file is part of Gneat.
 *
 * Gneat is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License (LGPL)
 * as published by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Gneat is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * and the GNU General Public License, for completeness, along with Gneat.  
 * If not, see <http://www.gnu.org/licenses/>.
 */
package org.neatshell.gneat.client.event.keyboard;

import org.neatshell.gneat.client.event.IDomEvent;
import org.neatshell.gneat.client.handler.Handler;

public interface IKeyEvent<H extends Handler> extends IDomEvent<H> {
	  /**
	   * Is <code>alt</code> key down.
	   *
	   * @return whether the alt key is down
	   */
	  public boolean isAltKeyDown();

	  /**
	   * Is <code>control</code> key down.
	   *
	   * @return whether the control key is down
	   */
	  public boolean isControlKeyDown();

	  /**
	   * Is <code>meta</code> key down.
	   *
	   * @return whether the meta key is down
	   */
	  public boolean isMetaKeyDown();

	  /**
	   * Is <code>shift</code> key down.
	   *
	   * @return whether the shift key is down
	   */
	  public boolean isShiftKeyDown();
	  
	  /**
	   * Does this event have any modifier keys down? Specifically. is the control,
	   * meta, shift, or alt key currently pressed?
	   * 
	   * @return whether this event have any modifier key down
	   */
	  public boolean isAnyModifierKeyDown();
}
